<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.project</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;project
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.project-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module project</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_altitude" class="summary-sig-name">get_altitude</a>()</span><br />
      Retrieves the current altitude of the site, relative to sea level.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_altitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_altitude" class="summary-sig-name">set_altitude</a>(<span class="summary-sig-arg">alt</span>)</span><br />
      Sets the altitude of the site, above sea level.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_altitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_client" class="summary-sig-name">get_client</a>()</span><br />
      Retrieves the text value used to identify the user who worked on the 
      model or the client for whom the model was created.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_client">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_client" class="summary-sig-name">set_client</a>(<span class="summary-sig-arg">client</span>)</span><br />
      Sets the text value used to identify the user who worked on the model
      or the client for whom the model was created.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_client">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_description" class="summary-sig-name">get_description</a>()</span><br />
      Retrieves the job description of the project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_description">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_description" class="summary-sig-name">set_description</a>(<span class="summary-sig-arg">description</span>)</span><br />
      Sets the job description of the project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_description">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_latitude" class="summary-sig-name">get_latitude</a>()</span><br />
      Retrieves the latitude of the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_latitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_latitude" class="summary-sig-name">set_latitude</a>(<span class="summary-sig-arg">lat</span>)</span><br />
      Sets the latitude of the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_latitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_location" class="summary-sig-name">get_location</a>()</span><br />
      Retrieves the location of the current model as latitude, longitude 
      and timezone.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_location">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_location" class="summary-sig-name">set_location</a>(<span class="summary-sig-arg">latitude</span>,
        <span class="summary-sig-arg">longitude</span>,
        <span class="summary-sig-arg">timezone</span>,
        <span class="summary-sig-arg">update</span>=<span class="summary-sig-default">True</span>)</span><br />
      Sets the location of the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_location">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_location_name" class="summary-sig-name">get_location_name</a>()</span><br />
      Retrieves the name of the current model location.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_location_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_location_name" class="summary-sig-name">set_location_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
      Sets the name of the current model location.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_location_name">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_longitude" class="summary-sig-name">get_longitude</a>()</span><br />
      Retrieves the longitude of the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_longitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_longitude" class="summary-sig-name">set_longitude</a>(<span class="summary-sig-arg">lng</span>)</span><br />
      Sets the longitude of the current model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_longitude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_north" class="summary-sig-name">get_north</a>()</span><br />
      Retrieves the North angle offset.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_north">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_north" class="summary-sig-name">set_north</a>(<span class="summary-sig-arg">north</span>)</span><br />
      Sets the North angle offset.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_north">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_reference" class="summary-sig-name">get_reference</a>()</span><br />
      Retrieves the job reference number for the project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_reference">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_reference" class="summary-sig-name">set_reference</a>(<span class="summary-sig-arg">description</span>)</span><br />
      Sets the job reference number of the project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_reference">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_terrain" class="summary-sig-name">get_terrain</a>()</span><br />
      Retrieves the type of terrain the project site is located on.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_terrain">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_terrain" class="summary-sig-name">set_terrain</a>(<span class="summary-sig-arg">terrain</span>)</span><br />
      Sets the type of terrain the project site is located on.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_terrain">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_timezone" class="summary-sig-name">get_timezone</a>()</span><br />
      Retrieves the timezone for the model location.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_timezone">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_timezone" class="summary-sig-name">set_timezone</a>(<span class="summary-sig-arg">tz</span>)</span><br />
      Sets the timezone of the model's location.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_timezone">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_title" class="summary-sig-name">get_title</a>()</span><br />
      Retrieves the title for the project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_title" class="summary-sig-name">set_title</a>(<span class="summary-sig-arg">description</span>)</span><br />
      Sets the title of the project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#get_type" class="summary-sig-name">get_type</a>()</span><br />
      Retrieves the building type.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_type">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.project-module.html#set_type" class="summary-sig-name">set_type</a>(<span class="summary-sig-arg">type</span>)</span><br />
      Sets the building type.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_type">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="get_altitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_altitude</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_altitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current altitude of the site, relative to sea level.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>alt The altitude as height above sea level.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_altitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_altitude</span>(<span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_altitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the altitude of the site, above sea level.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>alt The altitude as height above sea level.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_client"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_client</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_client">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the text value used to identify the user who worked on the 
  model or the client for whom the model was created.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A text string containing the result.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_client"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_client</span>(<span class="sig-arg">client</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_client">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the text value used to identify the user who worked on the model 
  or the client for whom the model was created.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>client A text string containing the new client name.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_description"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_description</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_description">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the job description of the project.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A text string containing the result.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_description"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_description</span>(<span class="sig-arg">description</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_description">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the job description of the project.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>description A text string containing the new description.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_latitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_latitude</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_latitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the latitude of the current model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>lat The latitude in decimal degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_latitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_latitude</span>(<span class="sig-arg">lat</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_latitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the latitude of the current model.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>lat The latitude in decimal degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_location"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_location</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_location">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the location of the current model as latitude, longitude and
  timezone.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>latitude The latitude in decimal degrees.</p>
  <p>longitude The longitude in decimal degrees.</p>
  <p>timezone The timezone as a GMT offset in decimal hours.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_location"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_location</span>(<span class="sig-arg">latitude</span>,
        <span class="sig-arg">longitude</span>,
        <span class="sig-arg">timezone</span>,
        <span class="sig-arg">update</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_location">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the location of the current model.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>latitude The latitude in decimal degrees.</p>
  <p>longitude The longitude in decimal degrees.</p>
  <p>timezone The timezone as a GMT offset in decimal hours.</p>
  <p>[update] If this optional parameter is set, the main window will be 
  updated with a redrawn view and sunpath. This is a boolean value where 1 
  or true represents the affirmative and 0 or false the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_location_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_location_name</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_location_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the name of the current model location.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name A text string representing the name of the location.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_location_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_location_name</span>(<span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_location_name">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the name of the current model location.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>name A text string representing the new name of the location.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_longitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_longitude</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_longitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the longitude of the current model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>lng The longitude in decimal degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_longitude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_longitude</span>(<span class="sig-arg">lng</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_longitude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the longitude of the current model.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>lng The longitude in decimal degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_north"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_north</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_north">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the North angle offset.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>angle The angle in degrees between true north and the positive Y 
  axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_north"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_north</span>(<span class="sig-arg">north</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_north">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the North angle offset.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>north The angle in degrees between true north and the positive Y 
  axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_reference"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_reference</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_reference">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the job reference number for the project.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A text string containing the result.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_reference"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_reference</span>(<span class="sig-arg">description</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_reference">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the job reference number of the project.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>description A text string containing the new reference number.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_terrain"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_terrain</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_terrain">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the type of terrain the project site is located on.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>terrain An integer value from following Terrain Types table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Terrain Types Token Value Description exposed 0 In a location exposed 
  to the wind rural 1 In a rural setting (reasonably open) suburban 2 In a 
  suburban setting (reasoanbly protected) urban 3 In a dense urban setting 
  (very protected)</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_terrain"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_terrain</span>(<span class="sig-arg">terrain</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_terrain">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the type of terrain the project site is located on.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>terrain The terrain type according to the following Terrain Types 
  table. This can be set as a token or a value.</p>
  <p>Relevant Data Table(s)</p>
  <p>Terrain Types Token Value Description exposed 0 In a location exposed 
  to the wind rural 1 In a rural setting (reasonably open) suburban 2 In a 
  suburban setting (reasoanbly protected) urban 3 In a dense urban setting 
  (very protected)</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_timezone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_timezone</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_timezone">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the timezone for the model location.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>tz The time zone as an offset from GMT in decimal hours.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_timezone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_timezone</span>(<span class="sig-arg">tz</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_timezone">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the timezone of the model's location.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>tz A GMT offset value in +/- decimal hours.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_title</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the title for the project.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result A text string containing the result.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_title</span>(<span class="sig-arg">description</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the title of the project.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>description A text string containing the new title.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_type</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#get_type">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the building type.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type An integer value corresponding to the following Project Types 
  table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Project Types Value Description 0 Domestic Dwelling 1 Commercial 
  Residential 2 Office/Shop/Assembly 3 Industrial or Storage 5 Other</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_type</span>(<span class="sig-arg">type</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.project-pysrc.html#set_type">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the building type.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>type An integer value corresponding to the following Project Types 
  table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Project Types Value Description 0 Domestic Dwelling 1 Commercial 
  Residential 2 Office/Shop/Assembly 3 Industrial or Storage 5 Other</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
